Interface EmailServer

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
EmailServerImpl

public interface EmailServer extends Process
Information provided by the PKI file:

    \class EmailServer
    
    \brief EmailServer is the process that handles the email server.
    
    \example network().getDevice("Server0").getProcess("EmailServer")
    
Author:
Auto-generated
  • Method Details

    • addUser

      boolean addUser(String name, String password)
      Information provided by the PKI file:
      
          \brief Adds an email user with the specified username and password.
          
          \param name, the username for the email user.
          \param password, the password for the email user.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      password - Takes in a parameter of password
      Returns:
      boolean Returns a boolean
    • deleteUser

      boolean deleteUser(String name)
      Information provided by the PKI file:
      
          \brief Removes the email user with the specified username.
          
          \param name, the username of the email user of interest.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • changePassword

      void changePassword(String name, String newpassword)
      Information provided by the PKI file:
      
          \brief Changes the password of the email user with the specifed username.
          
          \param name, the username of the email user of interest.
          \param newpassword, the new password for the email user.
          
              
      Parameters:
      name - Takes in a parameter of name
      newpassword - Takes in a parameter of newpassword
    • getEmailUser

      EmailUser getEmailUser(String username)
      Information provided by the PKI file:
      
          \brief Returns the email user with specified username.
          
          \param username, the username of the email user of interest.
          
          \return EmailUser, the EmailUser object with the specified username.
          
              
      Parameters:
      username - Takes in a parameter of username
      Returns:
      EmailUser Returns a EmailUser
    • getAllEmailAcctAsStrings

      List<String> getAllEmailAcctAsStrings()
      Information provided by the PKI file:
      
          \brief Adds an email user with the specified username and password.
          
          \return vector<string>, Return is all email accounts.  Each entry is in the format "name:password", like "jitu:jituPass".
          
              
      Returns:
      List<String> Returns a List<String>
    • updateAllAccounts

      void updateAllAccounts(String parm1)
      Information provided by the PKI file:
      
          \brief Updates passwords and adds user accounts based on the given formatted string.
          Format each entry as "name:password;".  So two entries would be formated as "name1:password1;name2:password2;"
          If a username exists, the password will be set.  If a username doesn't exist, the entry will be added.
          
              
      Parameters:
      parm1 - Takes in a parameter of parm1